 | IBM Endpoint Manager Inspectors Reference |
| IBM Endpoint Manager Inspectors Reference |
Win: Windows
Lin: Red Hat and SUSE Linux
Sol: SUN Solaris
HPUX: Hewlett-Packard UNIX version
AIX: IBM AIX
Mac: Apple Macintosh
Ubu: Ubuntu/Debian
WM: Windows Mobile
The version (e.g. Lin:8.1) corresponds to the version of the IEM product (8.1) in which the inspector was introduced in the client on that platform.
The version number is not shown if it is less than 8.0.
These Inspectors retrieve information about the application containing the relevance evaluator.
clientCreation Methods| Declaration | Description | Platforms (?) |
| client | Returns the client object corresponding to the BigFix application evaluating the current relevance expression. This is equivalent to the file system object of the BigFix Client executable. Example: pathname of parent folder of client - Returns the pathname corresponding to the folder containing the BigFix Client executable. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| administrator <string> of <client> | <setting> Plural: administrators | If the administrator named in the <string> is enabled on the given <client> computer, this property returns a setting with the given name and the value 'allow.' For instance, if the name of the administrator is joe_admin, then the client would return a setting object with the name 'joe_admin' and a value of 'allow'. Casting this as a string would return 'joe_admin=allow'. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| administrator of <client> | <setting> Plural: administrators | Returns one or more settings each representing an administrator of the client. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| setting <string> of <client> | <setting> Plural: settings | Returns a client setting whose name matches the string provided from the client settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| setting of <client> | <setting> Plural: settings | Returns one or more settings from the client settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
settingCreation Methods| Declaration | Description | Platforms (?) |
| setting <string> of <site> | Returns the setting whose name matches the string provided from the Fixlet site settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| setting of <site> | Returns one or more settings from the site settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| administrator <string> of <client> | If the administrator named in the <string> is enabled on the given <client> computer, this property returns a setting with the given name and the value 'allow.' For instance, if the name of the administrator is joe_admin, then the client would return a setting object with the name 'joe_admin' and a value of 'allow'. Casting this as a string would return 'joe_admin=allow'. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| administrator of <client> | Returns one or more settings each representing an administrator of the client. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| setting <string> of <client> | Returns a client setting whose name matches the string provided from the client settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| setting of <client> | Returns one or more settings from the client settings. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| <setting> as string | <string> | Returns a string formatted as <name>=<value> for the setting. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| effective date of <setting> | <time> Plural: effective dates | Returns the date when the setting was last modified. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| enabled of <setting> | <boolean> Plural: enableds | Returns TRUE if the specified setting is enabled. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| name of <setting> | <string> Plural: names | Returns the name of the setting. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| value of <setting> | <string> Plural: values | Returns the value of the setting. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
selected serverCreation Methods| Declaration | Description | Platforms (?) |
| selected server | The BES Server or BES Relay to which the agent reports. Returned as the "selected server" type. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| competition size of <selected server> | <integer> Plural: competition sizes | The number of servers in the competition from which this server was selected. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| competition weight of <selected server> | <integer> Plural: competition weights | The total of the weights of the servers in the competition from which this server was selected. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| distance of <selected server> | <integer range> Plural: distances | The distance, in IP gateway hops, to the server. Among servers with the same priority, closer servers are preferred. Returns an integer range, since the exact distance may not be known. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| gateway address <integer> of <selected server> | <ipv4or6 address> Plural: gateway addresses | During relay selection, a traceroute-like list of the hops between the client and its relay (the selected server) is recorded. The elements of that list is accessible through this Inspector.Prior to version 8.0, this inspector returned an <ipv4 address> type. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| gateway address of <selected server> | <ipv4or6 address> Plural: gateway addresses | During relay selection, a traceroute-like list of the hops between the client and its relay (the selected server) is recorded. That list is accessible through this Inspector. However, this Inspector ignores hops that don't reply. If you need the full list, use the 'full gateway address' Inspector.Prior to version 8.0, this inspector returned an <ipv4 address> type. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| ip address of <selected server> | <ipv4or6 address> Plural: ip addresses | The ipv4or6 address to which reports are sent.Prior to version 8.0, this inspector returned an <ipv4 address> type. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| name of <selected server> | <string> Plural: names | The DNS name of the server, if known. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| port number of <selected server> | <integer> Plural: port numbers | The port number to which reports are sent. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| priority of <selected server> | <integer> Plural: priorities | The priority assigned to the server by the BES console. Servers with low priorities are preferred to servers with high priority. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| weight of <selected server> | <integer> Plural: weights | The weight assigned to the server by the BES console. Servers with the same priority and approximate distance compete to be chosen; servers with higher weights are more likely to be chosen. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
client process ownerCreation Methods| Declaration | Description | Platforms (?) |
Properties| Declaration | Return type | Description | Platforms (?) |
current relayCreation Methods| Declaration | Description | Platforms (?) |
| current relay | Returns an object corresponding to the server or relay that the client last registered with. This may be a BES Relay or the BES root server. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| version of <current relay> | <version> Plural: versions | Returns a version object that is the version of the server that the client last registered with. This may be a BES Relay or the BES root server. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
root serverCreation Methods| Declaration | Description | Platforms (?) |
| root server | Returns an object representing the root BES Server to which the client last registered. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| host name of <root server> | <string> Plural: host names | The host (DNS) name of the BES root server that the BES Client last registered with. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| id of <root server> | <integer> Plural: ids | The DSA Server ID of the BES root server that the BES Client last registered with. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
evaluation cycleCreation Methods| Declaration | Description | Platforms (?) |
Properties| Declaration | Return type | Description | Platforms (?) |
application usage summaryCreation Methods| Declaration | Description | Platforms (?) |
| application usage summary | Returns an application usage summary containing information including the start time, duration and other statistics on client applications. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| application usage summary <string> | Returns the usage summary for the application specified in <string>. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
Properties| Declaration | Return type | Description | Platforms (?) |
| first start time of <application usage summary> | <time> Plural: first start times | Returns the start time of the specified application since the computer was configured to track it, regardless of reboots. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| last start time of <application usage summary> | <time> Plural: last start times | Returns the last time this specified application was started. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| last time seen of <application usage summary> | <time> Plural: last times seen | Returns the last time this specified application was seen running. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| name of <application usage summary> | <string> Plural: names | Returns the names of the applications that are currently enabled for usage summaries. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| running of <application usage summary> | <boolean> Plural: runnings | Returns TRUE if the specified application is currently running. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| total duration of <application usage summary> | <time interval> Plural: total durations | Returns the total elapsed time that the specified application has been running. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
| total run count of <application usage summary> | <integer> Plural: total run counts | Returns the number of times that the specified application has been run since the client was configured to track it. | Win, Lin, Sol, HPUX, AIX, Mac, WM, Ubu:8.1 |
application usage summary instanceCreation Methods| Declaration | Description | Platforms (?) |
Properties| Declaration | Return type | Description | Platforms (?) |